<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a name="line.1"></a>
<span class="sourceLineNo">002</span>/*<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Copyright (C) 2011 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * $Id: SocketHandler.html 689 2013-06-28 19:22:16Z archie.cobbs $<a name="line.5"></a>
<span class="sourceLineNo">006</span> */<a name="line.6"></a>
<span class="sourceLineNo">007</span><a name="line.7"></a>
<span class="sourceLineNo">008</span>package org.dellroad.stuff.net;<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>import java.io.IOException;<a name="line.10"></a>
<span class="sourceLineNo">011</span>import java.net.Socket;<a name="line.11"></a>
<span class="sourceLineNo">012</span><a name="line.12"></a>
<span class="sourceLineNo">013</span>/**<a name="line.13"></a>
<span class="sourceLineNo">014</span> * Implemented by objects that handle individual connections accepted by a {@link SocketAcceptor}.<a name="line.14"></a>
<span class="sourceLineNo">015</span> */<a name="line.15"></a>
<span class="sourceLineNo">016</span>public interface SocketHandler {<a name="line.16"></a>
<span class="sourceLineNo">017</span><a name="line.17"></a>
<span class="sourceLineNo">018</span>    /**<a name="line.18"></a>
<span class="sourceLineNo">019</span>     * Handle the connection.<a name="line.19"></a>
<span class="sourceLineNo">020</span>     *<a name="line.20"></a>
<span class="sourceLineNo">021</span>     * @param socket connection socket<a name="line.21"></a>
<span class="sourceLineNo">022</span>     * @throws IOException if needed<a name="line.22"></a>
<span class="sourceLineNo">023</span>     */<a name="line.23"></a>
<span class="sourceLineNo">024</span>    void handleConnection(Socket socket) throws IOException;<a name="line.24"></a>
<span class="sourceLineNo">025</span><a name="line.25"></a>
<span class="sourceLineNo">026</span>    /**<a name="line.26"></a>
<span class="sourceLineNo">027</span>     * Receive notification that the server is shutting down.<a name="line.27"></a>
<span class="sourceLineNo">028</span>     * This method should ensure that the thread currently executing {@link #handleConnection handleConnection()}<a name="line.28"></a>
<span class="sourceLineNo">029</span>     * returns as soon as possible.<a name="line.29"></a>
<span class="sourceLineNo">030</span>     *<a name="line.30"></a>
<span class="sourceLineNo">031</span>     * &lt;p&gt;<a name="line.31"></a>
<span class="sourceLineNo">032</span>     * After this method returns, the {@code socket} will be closed (if not already). So one way to implement this method<a name="line.32"></a>
<span class="sourceLineNo">033</span>     * is to simply do nothing, which will trigger an {@link IOException} on the next access from within<a name="line.33"></a>
<span class="sourceLineNo">034</span>     * {@link #handleConnection handleConnection()}.<a name="line.34"></a>
<span class="sourceLineNo">035</span>     *<a name="line.35"></a>
<span class="sourceLineNo">036</span>     * &lt;p&gt;<a name="line.36"></a>
<span class="sourceLineNo">037</span>     * Alternately, set some flag that {@link #handleConnection handleConnection()} detects each time around its processing loop,<a name="line.37"></a>
<span class="sourceLineNo">038</span>     * or use {@link Thread#interrupt}, etc.<a name="line.38"></a>
<span class="sourceLineNo">039</span>     *<a name="line.39"></a>
<span class="sourceLineNo">040</span>     * &lt;p&gt;<a name="line.40"></a>
<span class="sourceLineNo">041</span>     * In any case, it is important that {@link #handleConnection handleConnection()} thread does eventually return,<a name="line.41"></a>
<span class="sourceLineNo">042</span>     * otherwise the thread invoking {@link SocketAcceptor#stop SocketAcceptor.stop()} will hang.<a name="line.42"></a>
<span class="sourceLineNo">043</span>     *<a name="line.43"></a>
<span class="sourceLineNo">044</span>     * &lt;p&gt;<a name="line.44"></a>
<span class="sourceLineNo">045</span>     * Note: it may be that {@link #handleConnection handleConnection()} has already returned when this method is invoked,<a name="line.45"></a>
<span class="sourceLineNo">046</span>     * in which case this method should do nothing.<a name="line.46"></a>
<span class="sourceLineNo">047</span>     *<a name="line.47"></a>
<span class="sourceLineNo">048</span>     * &lt;p&gt;<a name="line.48"></a>
<span class="sourceLineNo">049</span>     *<a name="line.49"></a>
<span class="sourceLineNo">050</span>     * @param thread the thread invoking {@link #handleConnection handleConnection()}<a name="line.50"></a>
<span class="sourceLineNo">051</span>     * @param socket connection socket<a name="line.51"></a>
<span class="sourceLineNo">052</span>     */<a name="line.52"></a>
<span class="sourceLineNo">053</span>    void stop(Thread thread, Socket socket);<a name="line.53"></a>
<span class="sourceLineNo">054</span>}<a name="line.54"></a>
<span class="sourceLineNo">055</span><a name="line.55"></a>




























































</pre>
</div>
</body>
</html>
